Skip to content

[ALL-GENS;DEV-EX / EASE-OF-USE] - add javadocs to all codegens pointing to the dirs containing their relevant templates#23606

Open
Picazsoo wants to merge 3 commits intoOpenAPITools:masterfrom
Picazsoo:documentation/improve-navigation-from-generator-class-to-templates-via-javadoc
Open

[ALL-GENS;DEV-EX / EASE-OF-USE] - add javadocs to all codegens pointing to the dirs containing their relevant templates#23606
Picazsoo wants to merge 3 commits intoOpenAPITools:masterfrom
Picazsoo:documentation/improve-navigation-from-generator-class-to-templates-via-javadoc

Conversation

@Picazsoo
Copy link
Copy Markdown
Contributor

@Picazsoo Picazsoo commented Apr 23, 2026

When developing in OAP (introducing new functionality/fixing bugs), it is tiresome to search for the relevant directories containing the templates for each generator. This PR introduces javadocs to all the codegens making the ńavigation to the templates directories much easier.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request. - @wing328 - this is definitely just something nice-to-have. I find it very hard to find the directory containing the template files when I work in the codebase. But it is a matter of opinion definitely and maybe I am the only one with such issues and this should not be merged.

Summary by cubic

Added class-level Javadocs to all generators pointing to their template directories to make template discovery fast and consistent. For multi-library generators, docs list root vs libraries/ paths and note that library templates shadow root templates.

  • Refactors
    • Added Javadoc in each *Codegen class with its src/main/resources/... template path(s).
    • Standardized wording, noted template engines where needed (e.g., Handlebars in gdscript), and moved annotations below Javadocs so the docs attach to the class.

Written for commit 489dff0. Summary will update on new commits.

@Picazsoo Picazsoo changed the title [ALL-GENS;DOCUMENTATION/EASE-OF-USE] - add javadocs to all codegens pointing to the dirs containing the relevant templates [ALL-GENS;DOCUMENTATION/EASE-OF-USE] - add javadocs to all codegens pointing to the dirs containing their relevant templates Apr 23, 2026
@Picazsoo Picazsoo changed the title [ALL-GENS;DOCUMENTATION/EASE-OF-USE] - add javadocs to all codegens pointing to the dirs containing their relevant templates [ALL-GENS;DEV-EX / EASE-OF-USE] - add javadocs to all codegens pointing to the dirs containing their relevant templates Apr 23, 2026
@Picazsoo Picazsoo marked this pull request as ready for review April 23, 2026 11:27
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3 issues found across 161 files

Note: This PR contains a large number of files. cubic only reviews up to 75 files per PR, so some files may not have been reviewed. cubic prioritises the most important files to review.

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaHelidonClientCodegen.java">

<violation number="1" location="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaHelidonClientCodegen.java:46">
P3: Class Javadoc points only to the common template directory, but this generator also uses the client template directory, making the navigation guidance incomplete/misleading.</violation>
</file>

<file name="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/GdscriptClientCodegen.java">

<violation number="1" location="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/GdscriptClientCodegen.java:22">
P3: Javadoc says Mustache templates, but this generator uses Handlebars templates.</violation>
</file>

<file name="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaResteasyServerCodegen.java">

<violation number="1" location="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaResteasyServerCodegen.java:35">
P2: Class Javadoc is placed after `@Setter`, so tooling may not attach it to the class declaration.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

@Picazsoo Picazsoo marked this pull request as draft April 23, 2026 12:00
@Picazsoo Picazsoo marked this pull request as ready for review April 23, 2026 13:16
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 161 files

Note: This PR contains a large number of files. cubic only reviews up to 75 files per PR, so some files may not have been reviewed. cubic prioritises the most important files to review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant